API Documentation
Buffer.h
1 // Buffer.h
3 //
5 
6 namespace nkMemory
7 {
19  class Buffer final
20  {
21  public :
22 
23  // Constructors, destructor
27  Buffer () ;
34  Buffer (unsigned long long size) ;
41  Buffer (unsigned char* data, unsigned long long size) ;
48  Buffer (const Buffer& other) ;
55  Buffer (Buffer&& other) ;
60  ~Buffer () ;
61 
62  // Getters
66  unsigned char* getData () const ;
70  unsigned long long getSize () const ;
74  unsigned char& front () ;
78  unsigned char& back () ;
79 
80  // Management
84  void clear () ;
91  void resize (unsigned long long size) ;
99  unsigned char& append (unsigned char value) ;
100 
101  // Operators
108  unsigned char& operator[] (unsigned long long index) ;
115  const unsigned char& operator[] (unsigned long long index) const ;
116 
123  Buffer& operator= (const Buffer& other) ;
131 
132  public :
133 
134  // Constructors templated
140  template <typename T>
141  Buffer (const std::vector<T>& vec) ;
142  } ;
143 }
nkMemory::Buffer::getData
unsigned char * getData() const
nkMemory::Buffer::operator[]
unsigned char & operator[](unsigned long long index)
nkMemory::Buffer::resize
void resize(unsigned long long size)
nkMemory::Buffer::Buffer
Buffer(const std::vector< T > &vec)
nkMemory::Buffer::Buffer
Buffer(unsigned long long size)
nkMemory::Buffer::Buffer
Buffer()
nkMemory::Buffer::~Buffer
~Buffer()
nkMemory::Buffer
A buffer holding binary data.
Definition: Buffer.h:20
nkMemory::Buffer::Buffer
Buffer(Buffer &&other)
nkMemory::Buffer::back
unsigned char & back()
nkMemory::Buffer::getSize
unsigned long long getSize() const
nkMemory::Buffer::Buffer
Buffer(const Buffer &other)
nkMemory::Buffer::clear
void clear()
nkMemory::Buffer::append
unsigned char & append(unsigned char value)
nkMemory::Buffer::front
unsigned char & front()
nkMemory::Buffer::Buffer
Buffer(unsigned char *data, unsigned long long size)
nkMemory::Buffer::operator=
Buffer & operator=(const Buffer &other)
nkMemory
Encompasses all API of component NilkinsMemory.
Definition: Allocator.h:7